Release notes

2023r9

Custom attributes in person API

Custom attributes were already supported in the content, MAM and trailer API.

From this version, the person API also supports custom attributes of the following types:

  • Boolean

  • Date

  • Decimal number

  • Drop-down list

  • Drop-down list for multiselection

  • Duration

  • Integer

  • Reference

  • String

  • Text

  • Web

In the GET /person call, the following suffixes can be added to the URL to either get only the specified attributes in the response or all custom attributes of the supported types:

  • ?customAttributes=attributeName,attributeName

  • ?customAttributes=allCustomAttributes

For example: GET /persons/1111882517?customAttributes=commute,hobby

For each custom attribute, the attribute name, value and type will be given. For example:

    "customAttributes": [
        {
            "attributeName": "commute",
            "value": "01:58:00",
            "type": "Duration field"
        },
        {
            "attributeName": "hobby",
            "value": "Cinema",
            "type": "String field"
        }
    ]

For custom attributes of the type Drop-down list or Drop-down list for multiselection, a GET /dropdown/customAttribute/{attributeName} call has been added to the API to retrieve the possible values. The {attributeName} should be replaced with the actual attribute name of the custom attribute.

For example, GET /person/v1/dropdown/customAttribute/payDepartment.

To update one or more custom attributes on a person using the POST or PUT /person calls, an array needs to be provided with their attribute name and value:

    "customAttributes": {
            "payDepartment": "Movies",
            "commute": "01:56:00.000",
            "hobby": "Cinema"
        }

If the value is left empty by using null or "" for some types, the custom attribute is emptied.

The YAML has been updated for these changes.

2021r3.000

Create person without real name

In version 2020r2.002, the person API was adapted to support cast members in the content API.

From that version, on the PSIPersonNameType drop-down list, it became possible to indicate which name types should be added by default when creating a new person. However, it became possible to create a person without a Real name or without the name types that are supposed to be added by default.

This issue has been fixed.

When the real name is not provided in the namesList, the error The namesList should at least include the real name. is returned.

When the names list does not include the name types that should be added by default, the error The namesList should include the [name types marked as add by default]. is returned.

2020r2.000

API version: v1.0.0

Addition of Person API

From this version on, it is possible to manage persons using the Person API and support cast members in the content API.